Clinical Trials Tableau System API - Implementation Template

HLS Clinical Trials Tableau System API Dev Guide

This guide provides information on supporting functions for translating Veeva
data into Tableau format.

cdmsConversionTools

A library that implements tools for CDMS that converts
from Veeva to Tableau format.

Source: ./src/main/resources/dwl/cdmsConversionTools.dwl

Functions

fun createDemographics (demoDataSet)

Converts the Veeva formatted demographics data to the Tableau formatted table structure.

param demoDataSet is an array of objects with the Veeva demographics data.
return An array of objects with the Tableau format.

fun createVitalSigns (vitalSignsDataSet)

Converts the Veeva formatted vital signs data to the Tableau formatted table structure.

param createVitalSigns is an array of objects with the Veeva vital signs data.
return An array of objects with the Tableau format.

fun createPhysicalExam (peDataSet)

Converts the Veeva formatted physical exam data to the Tableau formatted table structure.

param peDataSet is an array of objects with the Veeva physical exam data.
return An array of objects with the Tableau format.

fun createSubjects (subjectDataSet)

Converts the Veeva formatted subjects data to the Tableau formatted table structure.

param subjectDataSet is an array of objects with the Veeva subjects data.
return An array of objects with the Tableau format.

fun createAE (aeDataSet)

Converts the Veeva formatted adverse events data to the Tableau formatted table structure.

param aeDataSet is an array of objects with the Veeva adverse events data.
return An array of objects with the Tableau format.

(back to top)

ctmsConversionTools

A library that implements tools for CTMS that converts
from Veeva to Tableau format.

Source: ./src/main/resources/dwl/ctmsConversionTools.dwl

Functions

fun createCtmsSubjects (subjectData)

Converts the Veeva formatted subjects data to the Tableau formatted table structure.

param subjectData is an array of objects with the Veeva subject data.
return An array of objects with the Tableau format.

fun createCtmsStudies (studyData)

Converts the Veeva formatted studies data to the Tableau formatted table structure.

param studyData is an array of objects with the Veeva study data.
return An array of objects with the Tableau format.

fun createCtmsSites (siteData)

Converts the Veeva formatted sites data to the Tableau formatted table structure.

param siteData is an array of objects with the Veeva site data.
return An array of objects with the Tableau format.

fun createCtmsEnrollment (enrollmentData)

Converts the Veeva formatted enrollment data to the Tableau formatted table structure.

param enrollmentData is an array of objects with the Veeva enrollment data.
return An array of objects with the Tableau format.

fun createCtmsStudyCountry (studyCountryData)

Converts the Veeva formatted study country data to the Tableau formatted table structure.

param studyCountryData is an array of objects with the Veeva study country data.
return An array of objects with the Tableau format.

fun createCtmsStudyArm (studyArmData)

Converts the Veeva formatted study arm data to the Tableau formatted table structure.

param studyArmData is an array of objects with the Veeva study arm data.
return An array of objects with the Tableau format.

fun createCtmsVisitDefinition (visitDefinitionData)

Converts the Veeva formatted visit definition data to the Tableau formatted table structure.

param visitDefinitionData is an array of objects with the Veeva visit definition data.
return An array of objects with the Tableau format.

fun createCtmsVisit (visitData)

Converts the Veeva formatted visit data to the Tableau formatted table structure.

param visitData is an array of objects with the Veeva visit data.
return An array of objects with the Tableau format.

(back to top)

hyperSchema

This module defines functions for handling
hyper schema creation and upload.

Source: ./src/main/resources/dwl/hyperSchema.dwl

Functions

fun generateCsvFileName (source, businessObject)

Generates a globally unique file name for the processing of a tableau table with the provided source and businessObject fields.

param source is a String with the source.
param businessObject is a String with the business object.
return A globally unique string to be used as a file name without an extension.

fun getHyperInfo (source, businessObject)

Gets the hyper file info for the provided source and businessObject. This information is used to create the upload datasource message.

param source is a String with the source.
param businessObject is a String with the business object.
return An object with fields needed to create the datasource message or an empty object if not matched.

fun getHyperSchema (source, businessObject)

Gets the hyper schema structure for the provided source and businessObject fields.

param source is a String with the source.
param businessObject is a String with the business object.
return the hyper schema for the provided fields or an empty array if not matched.

(back to top)

hyperSchemaCdms

This module defines CDMS schemas.

Source: ./src/main/resources/dwl/hyperSchemaCdms.dwl

Functions

fun getCdmsSubjectsSchema ()

Generates the CDMS subjects hyper schema.

return An array of objects with the hyper schema.

fun getCdmsSubjectDemographicsSchema ()

Generates the CDMS subject demographics hyper schema.

return An array of objects with the hyper schema.

fun getCdmsSubjectVitalsSchema ()

Generates the CDMS subject vitals hyper schema.

return An array of objects with the hyper schema.

fun getCdmsSubjectPhysicalsSchema ()

Generates the CDMS subject physicals hyper schema.

return An array of objects with the hyper schema.

fun getCdmsAdverseEventsSchema ()

Generates the CDMS adverse events hyper schema.

return An array of objects with the hyper schema.

(back to top)

hyperSchemaCtms

This module defines CTMS schemas.

Source: ./src/main/resources/dwl/hyperSchemaCtms.dwl

Functions

fun getCtmsSubjectsSchema ()

Generates the CTMS subjects hyper schema.

return An array of objects with the hyper schema.

fun getCtmsStudiesSchema ()

Generates the CTMS studies hyper schema.

return An array of objects with the hyper schema.

fun getCtmsSitesSchema ()

Generates the CTMS sites hyper schema.

return An array of objects with the hyper schema.

fun getCtmsEnrollmentSchema ()

Generates the CTMS enrollment hyper schema.

return An array of objects with the hyper schema.

fun getCtmsStudyCountriesSchema ()

Generates the CTMS study countries hyper schema.

return An array of objects with the hyper schema.

fun getCtmsStudyArmsSchema ()

Generates the CTMS study arms hyper schema.

return An array of objects with the hyper schema.

fun getCtmsVisitDefinitionsSchema ()

Generates the CTMS visit definitions hyper schema.

return An array of objects with the hyper schema.

fun getCtmsVisitsSchema ()

Generates the CTMS visits hyper schema.

return An array of objects with the hyper schema.

(back to top)